"""myDjango URL Configuration

The `urlpatterns` list routes URLs to views. For more information please see:
    https://docs.djangoproject.com/en/2.1/topics/http/urls/
Examples:
Function views
    1. Add an import:  from my_app import views
    2. Add a URL to urlpatterns:  path('', views.home, name='home')
Class-based views
    1. Add an import:  from other_app.views import Home
    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
Including another URLconf
    1. Import the include() function: from django.urls import include, path
    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
"""
from django.contrib import admin
from django.urls import path
from rest_framework.documentation import include_docs_urls

from users import views
from django.conf.urls import url, include
# 总路由
urlpatterns = [
    path('admin/', admin.site.urls),

    # 把users应用中的所有路由信息包含到总路由中
    # url(r"^users/", include("users.urls"))

    # 只在总路由中包含子应用的路由
    # url(r"^", include("users.urls"))

    # 只在总路由中去定义路由
    # url(r"^users/index/$", views.index),

    # 只在总路由中包含子应用的路由
    # url(r"^", include(("users.urls", "users"), namespace="users")),

    # 包含子应用
    # url(r"^", include(("request_response.urls", "request_response"), namespace="request_response")),

    # classview
    url(r"^", include("classview.urls")),

    # 管理后端图书
    url(r"^", include("booktest.urls")),


    # 自动生成接口文档 --> 设置接口文档访问路径
    # 只有DRF下的视图才会生成API文档
    url(r'^docs/', include_docs_urls(title='小辉辉API文档')),
    """
        API文档注意点: 
                    1） 视图集ViewSet中的retrieve名称，在接口文档网站中叫做read

                    2）参数的Description需要在模型类或序列化器类的字段中以help_text选项定义
    """

]
